CTooltipSupport Class Reference

Generic Tooltip Support class. More...

Inheritance diagram for CTooltipSupport:
Inheritance graph
[legend]
Collaboration diagram for CTooltipSupport:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 CTooltipSupport (CFrame *frame, int32_t delay=1000)
void onMouseEntered (CView *view)
void onMouseExited (CView *view)
void onMouseMoved (const CPoint &where)
void onMouseDown (const CPoint &where)
void hideTooltip ()
Reference Counting Methods



virtual void forget ()
 decrease refcount and delete object if refcount == 0
virtual void remember ()
 increase refcount
virtual int32_t getNbReference () const
 get refcount
Message Methods



virtual CMessageResult notify (CBaseObject *sender, IdStringPtr message)

Protected Types

enum  {
  kHidden, kVisible, kHiding, kShowing,
  kForceVisible
}

Protected Member Functions

 ~CTooltipSupport ()
bool showTooltip ()
CMessageResult notify (CBaseObject *sender, IdStringPtr msg)

Protected Attributes

CVSTGUITimertimer
CFrameframe
SharedPointer< CViewcurrentView
int32_t delay
int32_t state
CPoint lastMouseMove

Detailed Description

Generic Tooltip Support class.

A generic way to add tooltip support to VSTGUI.

Example

Adding a tooltip to a view

UTF8StringPtr tooltipText = "This is a tooltip";
view->setAttribute (kCViewTooltipAttribute, strlen (tooltipText)+1, tooltipText);

Adding CTooltipSupport is done via VSTGUI::CFrame::enableTooltips (true)


Member Enumeration Documentation

anonymous enum [protected]
Enumerator:
kHidden 
kVisible 
kHiding 
kShowing 
kForceVisible 

Constructor & Destructor Documentation

CTooltipSupport ( CFrame frame,
int32_t  delay = 1000 
)
Parameters:
frame CFrame object
delay tooltip delay time in milliseconds
~CTooltipSupport (  )  [protected]

Member Function Documentation

virtual void forget (  )  [inline, virtual, inherited]

decrease refcount and delete object if refcount == 0

virtual int32_t getNbReference (  )  const [inline, virtual, inherited]

get refcount

void hideTooltip (  ) 
virtual CMessageResult notify ( CBaseObject sender,
IdStringPtr  message 
) [inline, virtual, inherited]
CMessageResult notify ( CBaseObject sender,
IdStringPtr  msg 
) [protected]
void onMouseDown ( const CPoint where  ) 
void onMouseEntered ( CView view  ) 
void onMouseExited ( CView view  ) 
void onMouseMoved ( const CPoint where  ) 
virtual void remember (  )  [inline, virtual, inherited]

increase refcount

bool showTooltip (  )  [protected]

Member Data Documentation

int32_t delay [protected]
CFrame* frame [protected]
CPoint lastMouseMove [protected]
int32_t state [protected]
CVSTGUITimer* timer [protected]

The documentation for this class was generated from the following files:

Generated on Fri Nov 22 11:09:57 2013 for VSTGUI by  doxygen 1.6.1